Skip to content
This repository was archived by the owner on Aug 10, 2026. It is now read-only.

[AIT-1226] Merge the AI Transport About and Why pages into one landing page - #3505

Draft
VeskeR wants to merge 4 commits into
mainfrom
AIT-1226/why-page
Draft

[AIT-1226] Merge the AI Transport About and Why pages into one landing page#3505
VeskeR wants to merge 4 commits into
mainfrom
AIT-1226/why-page

Conversation

@VeskeR

@VeskeR VeskeR commented Jul 31, 2026

Copy link
Copy Markdown
Contributor

Closes AIT-1226.

Collapses Getting started > About AI Transport and Why AI Transport? > Overview into one page, and moves Why AI Transport? above Getting started:

Why AI Transport?            Getting started
  Overview                     By SDK
  HTTP streaming and AI        Set up authentication
                               Configure the channel rule

The merged page stays at /docs/ai-transport so the product entry point keeps its URL. /docs/ai-transport/why redirects to it and picks up the /docs/ai-transport/concepts/infrastructure redirect the deleted page carried. why/http-streaming-and-ai.mdx keeps its URL.

The page is rewritten rather than concatenated. It opens on the failure modes a reader already has, uses one comparison table as the central artifact with the feature links in it, adds a section on what adopting a session layer costs you, and shows both the agent-side and client-side code seams. Claims the old pages made that roadmap.mdx, the feature pages, or the SDK typings do not support have been dropped.

The other five files are link updates to match.

🤖 Generated with Claude Code

Two pages at the top of the AI Transport nav were doing overlapping jobs:
"About AI Transport" introduced the product, and "Why AI Transport"
argued for it. A reader arriving from marketing or from another product's
docs had to read both to get either answer, and each page repeated the
other's framing. Collapsing them puts the high-level content in one place
and lets the "Why AI Transport?" section sit above "Getting started",
where the question it answers actually gets asked.

The merged page keeps /docs/ai-transport, because that is the URL 26
inbound references already use as the product entry point, and moving it
would have put a redirect on the highest-traffic path into the section.

The page is written to answer necessity rather than comprehension. Two
founder calls in late July concluded that readers understood the product
and still could not see why they needed it before a V2, and that the
scale-oriented framing actively invited "nice to have". So the page opens
on the failure modes a reader already has, states that the threshold is
response duration rather than traffic volume, shows both seams that
change when retrofitting an application that already streams, and names
the constraints and dependencies adoption brings.

Several claims carried by the old pages are gone because the roadmap, the
feature pages, and the SDK do not support them: LangChain and native
model-provider integrations, human handover, two platform statistics that
appear nowhere else in the docs, and a publish-order guarantee that
message-ordering.mdx explicitly refutes for cross-region publishers.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 31, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on this repository. Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bdb1b53c-4749-4a4b-9fee-4d7b8edd9f8a

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • 🔍 Trigger review

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@VeskeR VeskeR added the review-app Create a Heroku review app label Jul 31, 2026
@ably-ci
ably-ci temporarily deployed to ably-docs-ait-1226-why--4hgcm7 July 31, 2026 01:38 Inactive
@VeskeR
VeskeR marked this pull request as draft July 31, 2026 09:51
The tradeoffs table hung data portability off webhook and Kafka egress,
which does not support it: those sources document channel.message, and
nothing says the append operations that carry a streamed response are
delivered outbound. Dropping the claim entirely was the wrong correction,
because database hydration does support it by a different route: an agent
that persists each completed run holds the conversation, since the union
of completed runs reconstructs it losslessly.

Gives that its own row sourced to database hydration, and leaves webhooks
and Kafka scoped to the analytics and audit use they are documented for.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@ably-ci
ably-ci temporarily deployed to ably-docs-ait-1226-why--4hgcm7 July 31, 2026 12:22 Inactive
@VeskeR VeskeR changed the title Merge the AI Transport About and Why pages into one landing page [AIT-1226] Merge the AI Transport About and Why pages into one landing page Jul 31, 2026
VeskeR and others added 2 commits August 7, 2026 13:59
Review feedback was that the page read as machine-written: smartassy.
The style-guide checklist was clean, so the problem sat above it. Reading
it back, almost nothing was described and everything was argued. Every
section closed on a line shaped like a slide title, the same
this-not-that frame carried every paragraph, and plain verbs had been
swapped for more interesting ones throughout. Those are the tells, so
this strips them: the rhetorical triples, the objections raised only to
be knocked down, the reveals, and the closers.

The argument is also now in two parts rather than one table mixing both.
The first covers what moving off HTTP streaming fixes, which is the same
product with the failures taken out: resume, second device, reload, stop,
concurrent turns, agent restart. The second covers what the session adds
because it is an Ably channel with a conversation tree over it, and none
of which HTTP streaming can express at all: branching and regenerate,
agent and client presence, shared live state, steering, approval gates,
chain of thought.

The agent sample was not runnable, since the streamText result it piped
was never defined. It is now a complete handler, with the body in
try/finally because session.end closes a still-open run rather than
leaving observers stuck on streaming.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
A second read found that removing a device tended to put an equivalent
one back two lines away, in a new slot. The reveal that opened the page
came back as an antithesis couplet in the paragraph below it. The
objection about traffic volume came back one synonym over. The scaffold
that announced the setup steps moved from the front of its paragraph to
the back as a three-word fragment. Two more scaffolds appeared in a
section that previously went straight from heading to table.

Cuts those, states the scale point as a single fact, breaks the first
table out of a shape where four rows opened the same way and five closed
the same way, and puts the cost before the mitigation in the row that
discloses the extra round trip.

Also restores the drain comment to the warning it was. Explaining the
same thing in two balanced sentences reads as documentation; the original
"do this, or X happens" reads like someone who hit it.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

review-app Create a Heroku review app

Development

Successfully merging this pull request may close these issues.

2 participants